home *** CD-ROM | disk | FTP | other *** search
/ E.M.Computergraphic Phase 4 / Phase 4 - Desktop Video Dreams (E. M. Computergraphic)(1996).iso / utilities / jacosub / jacosub.readme < prev    next >
Text File  |  1996-01-02  |  35KB  |  745 lines
  1.          JACOsub: video subtitling software for professionals
  2.                              version 1.5
  3.                          Timed Script Player
  4.              A Product from Unicorn Research Corporation
  5.  
  6.  
  7. SPECIAL FEATURES
  8. ================
  9.  
  10.  *  Non-sequential events!  Title time ranges may overlap.
  11.  
  12.  *  Display graphic images with the text!  Time ranges for graphic images
  13.     may overlap also.  Graphics (pictures or brushes) may be positioned
  14.     anywhere on the screen.
  15.  
  16.  *  Complete control over text position, margins, font, style, colors,
  17.     backshadow, word-wrapping, and justification!  You can even generate
  18.     outlines and shadows on mono-color text!  Text appearance can be
  19.     controlled through line directives or with C-style escape code inside
  20.     the subtitle text.
  21.  
  22.  *  Handles all kinds of time units: SMPTE, 1/100 second units, etc.
  23.  
  24.  *  Extremely flexible timing script file format, allowing comments, blank
  25.     lines, text directives, and global configuration commands.  Scripts can
  26.     be as simple or as complex as you want.  Scripts may even include other
  27.     scripts, so you don't have to re-time things that you use over and over
  28.     again!
  29.  
  30.  *  Support for 3rd-party script formats:  TurboTitle (.tts), Phoenix
  31.     Japanimation Society (.pjs), generic (.tim), Panimator (.pan), and also
  32.     Subtitle (.sub) format.  A conversion utility is provided to convert
  33.     all these formats to JACOsub (.js) format.  JACOsub can read directly
  34.     all but .pan and .sub scripts without prior conversion.
  35.  
  36.  *  TRUE video buffering.  Most good Amiga titling programs generate
  37.     displays in a background buffer, then blit it to the foreground at the
  38.     proper time.  But the duration of a multi-bitplane blit can be up to 3
  39.     video frames.  This can cause disconcerting "flashing" effects.  Both
  40.     TurboTitle and PJS's software have this problem.  JACOsub has a
  41.     better way:  It uses video-page switching rather than blitting, to
  42.     move displays to the foreground.  Text appears during the vertical CRT
  43.     blanking interval.  Instantaneous!  Blitting is used only when some
  44.     text has a lifespan extending over multiple time events; in this case,
  45.     the text is blitted (rather than re-generated) onto other background
  46.     display buffers.  JACOsub uses 4 video buffers by default.
  47.  
  48.  *  You can make shift and ramp timing adjustments "on the fly" while your
  49.     script is playing.
  50.  
  51.  *  Lets you control the Digital Creations SuperGen genlock fader controls
  52.     directly from your script!
  53.  
  54.  *  Robust diagnostics for tracking down problems in your scripts.
  55.  
  56.  
  57.  
  58. Author:  Alex Matulich
  59.          Unicorn Research Corporation
  60.          4621 N. Landmark Drive
  61.          Orlando, FL 32817-1235
  62.          (407) 657-4974
  63.          FAX (407) 657-6149
  64.  
  65. Technical Consultant:  Daric (Jingoro) Kozlowski
  66. Beta Testers:  Daric Kozlowski (Japanese Animation Club of Orlando)
  67.                Tom Perry (Phoenix Japanimation Society)
  68.                Noel Gamboa (Operation X)
  69.                Robert Lowrey (Central Anime)
  70.                Roger Ang, Dave Fleming, Mike Harlock,
  71.                Tommy Hwang, Ed Sum
  72.  
  73. Compiler:  SAS Amiga C 6.2
  74. Computer:  Amiga 1000 (never say die!)
  75.            AmigaDOS 2.04 ROM hacked in, 2M FAST, 512K CHIP, 30MB C-Ltd HD
  76.  
  77. NOTE: I deeply apologize for the spartan user interface!  I am working on
  78. a way to integrate editing and timing capabilities.  Currently, the program
  79. will only play scripts.  For generating timing events for scripts, you will
  80. have to use something like TurboTitle for now, OR you can make a VCR
  81. recording of your video with JACOsub's running clock overlaid onto it, so
  82. that you can see when each time event should occur.
  83.  
  84.  
  85.  
  86. INSTALLATION
  87. ============
  88.  
  89. After extracting the archive you should have these files (an "I" in the
  90. first column indicates that the file has an icon (.info file) associated
  91. with it).
  92.  
  93. I  README.1st                  Quick install and run instructions
  94. I  CHANGES.TXT                 List of improvements and bug fixes
  95. I  InstallFonts                Installs JACOsub's fonts into fonts:
  96. I  JACOsub                     The timing script compiler & player
  97. I  JACOsub.info                Program icon
  98. I  JACOsub.cfg                 Optional configuration file
  99. I  JACOsub.doc                 You're reading it now
  100. I  JScripts.doc                JACOsub Script file format specification
  101. I  jconvert                    Conversion utility for 3rd-party scripts
  102.    fonts (subdirectory)
  103.       JACOsub.font             Professional-quality video titling fonts
  104.       JACOsub (subdirectory)
  105.          24e                   24-pixel height monochrome font
  106.          29.C                  29-pixel international color font
  107.          36.C                  36-pixel international color font
  108. I  scripts (subdirectory)
  109. I     demo.js                  Demonstration script for JACOsub
  110. I     idemo.js                 Secondary script included by demo.js
  111. I     JACO.bbm                 Graphic logo; IFF brush used by demo.js
  112.  
  113. All you need to do to install the software after you extract the archive,
  114. is copy the supplied fonts to your fonts: directory.  You can click twice
  115. on the "InstallFonts icon, or enter these commands from a Shell:
  116.  
  117.    copy fonts fonts: all       ;copy the supplied fonts
  118.    delete fonts all            ;delete the fonts directory created by the
  119.                                ;archive extraction.
  120.  
  121. If you have a SuperGen genlock, you need to make sure that your LIBS:
  122. directory contains supergen.library and copinit.library.  If they are
  123. missing, you won't be able to control your SuperGen from JACOsub scripts.
  124.  
  125. Now we're ready to begin.  But first, a note to users of various versions
  126. of AmigaDOS:
  127.  
  128.    AmigaDOS 1.2:  You will not be able to run JACOsub with color fonts.
  129.    If you boot up with a 1.3 disk using 1.2 Kickstart, you may have better
  130.    luck.  In any case, upgrade to 1.3 or 2.0 as soon as you can.  Your
  131.    libs: directory should contain req.library, though it's not required.
  132.  
  133.    AmigaDOS 1.3:  You will need to load a Colortext driver prior to
  134.    running JACOsub.  A good Colortext driver by InterActive Softworks is
  135.    supplied with Deluxe Paint IV or Calligrapher.  If you don't load this
  136.    driver, you will see only single-colored characters while JACOsub runs.
  137. >> DO NOT USE ColorTextWedge 1.2 (supplied with TurboTitle) -- it forces
  138.    all text into JAM2 mode which chops up fonts having overlapping
  139.    dropshadows (such as the supplied JACOsub font).  Also, your libs:
  140.    directory should contain req.library, though it's not required.
  141.  
  142.    AmigaDOS 2.0 users do not need any special driver -- it's built into
  143.    2.0, and it's a little bit faster, too.  You don't need req.library,
  144.    but your libs: directory should contain the AmigaDOS asl.library.
  145.  
  146.    AmigaDOS 3.0:  Should behave the same as AmigaDOS 2.0.
  147.  
  148. ALL USERS:  DO NOT use JACOsub with Directory Opus 4.0!  This version of
  149.    Directory Opus has some known problems that will cause you a lot of
  150.    grief if you try to run JACOsub with it.  We recommend you avoid
  151.    directory utilities altogether when running JACOsub!
  152.  
  153.    Some users have reported that certain text editors, when run in the
  154.    background while JACOsub is running, will mess up script timing.  We
  155.    have had no problems with TxED or CED.  In any case, it is probably a
  156.    good idea to shut down unnecessary tasks before running ANY timing-
  157.    critical application such as JACOsub.
  158.  
  159.    You should have either asl.library or req.library in your libs:
  160.    directory.  The program will still work fine without these, however.
  161.    Warning:  I have observed instances of req.library trashing memory
  162.    location $00000078 (in the zero-page memory area) which is dangerous for
  163.    AmigaDOS.  If the computer crashes right before a file requester should
  164.    appear, the fault is with req.library, not JACOsub.
  165.  
  166.  
  167.  
  168. RUNNING THE PROGRAM
  169. ===================
  170.  
  171. Workbench
  172. ---------
  173. Just click twice on the icon to start the program.  Skip to the "Menu"
  174. section below.
  175.  
  176. Shell
  177. -----
  178. The Shell command for running JACOsub is simply
  179.  
  180.    jacosub [-switches] [scriptname]
  181.  
  182. Command arguments are optional.  Scriptname is the name of the script to
  183. play.  If you specify ONLY the root name of your script (that is, with no
  184. .extension), JACOsub will look for the following 5 files:
  185.  
  186.    scriptname.jsc      (compiled JACOsub script)
  187.    scriptname.js       (JACOsub script)
  188.    scriptname.tts      (TurboTitle script)
  189.    scriptname.pjs      (Phoenix Japanimation Society script)
  190.    scriptname.tim      (generic timed script [actually same as .pjs])
  191.  
  192. If more than one of these are found, the newest one will be read in.  If
  193. it's not a compiled script, JACOsub will compile it before playing it.
  194. JACOsub always automatically saves its compiled script so that it will
  195. load up quickly in the future (it can take a few minutes to compile a
  196. longish script).  The compiled script is typically over 3 times the size
  197. of the uncompiled version.  You can disable this automatic saving by
  198. setting SAVECOMPILED to NO in JACOsub.cfg (see the section below titled
  199. OPTIONAL CONFIGURATION FILE).
  200.  
  201. If you DO specify one of the above extensions in your script name, then
  202. JACOsub will attempt to load that specific script.
  203.  
  204. Switches:
  205.  
  206. -config lets you specify a configuration file.  The file name must appear
  207.         following a space after the -config switch.  If this switch is
  208.         omitted, JACOsub will look for the file JACOsub.cfg in the current
  209.         directory.
  210.  
  211. -play   forces the program directly into play mode, skipping the main menu,
  212.         compiling the script if necessary.  You must specify a script name
  213.         also.  The program will return to the main menu after play
  214.         terminates or after an error occurs.  You must press a key to start
  215.         the script playing.
  216.  
  217. -any other switch causes a help message to be displayed.
  218.  
  219. During script compilation, JACOsub will inform you of its progress as
  220. well as any errors that it finds in your script.
  221.  
  222. Menu
  223. ----
  224. If you omitted the script name on the command line, JACOsub will skip right
  225. to the main menu, which has these options:
  226.  
  227.    [L]oad a new script         (enter root file name as described above)
  228.    [P]lay script               (plays the script -- press ESC to abort it)
  229.    [M]ode of play              (cycles through different play modes; i.e.
  230.                                 real-time, real-time w/clock, step-play)
  231.    [T]ime shift                (shift all times by some amount)
  232.    [R]amp time                 (ramp-time adjustment for playing scripts)
  233.    [I]ncremental adjustment    (sets increment for on-the-fly adjustments)
  234.    [B]egin play at time...     (specify where in the script to begin play)
  235.  
  236.    [D]irectory for scripts     (set a new script directory - this option
  237.                                 doesn't appear if you have asl.library
  238.                                 or req.library in your libs: directory)
  239.    [Q]uit
  240.  
  241. Just press the key corresponding to your choice.  You will be prompted for
  242. a new script name if you select L.  You can select P, T, R, or B only if
  243. there is a compiled script in memory.  And, of course, Q quits the program.
  244.  
  245. ABOUT PLAYING THE SCRIPT:  During play, you can make ramp time adjustments
  246. on the fly.  Suppose you have the Incremental Adjustment set to .25 sec.
  247. Pressing the down-arrow key will decrease the ramp time adjustment by .25
  248. seconds, and pressing the up-arrow key will increase it by .25 seconds.
  249. THE CHANGE WILL OCCUR AT THE TIME-POINT WHERE YOU CHANGED IT.  For example,
  250. if the script play is 20% complete (1/5 done) and you pressed the up-arrow
  251. key, time events would be increased by .25 seconds AT THAT TIME -- this
  252. would increase the ENDING ramp time by five times that amount (i.e. 1.25
  253. seconds) because the play is only 1/5 complete at the time you made the
  254. change.  When the playing is done, the resulting ramp time will be
  255. displayed in the ain Menu.
  256.  
  257. Beware of adjusting ramp time near the beginning of the script!  Doing this
  258. too early in the play will result in a drastically huge change at the end.
  259. Don't be disconcerted by the Ramp display on the running clock; it shows
  260. the ENDING ramp adjustment.  On-the-fly ramp adjusting is *wonderful* when
  261. you get used to it.  Usually you will only have to make two or three
  262. adjustments during the script play, whereas straight time shift adjustments
  263. have to be done many times to keep the script in sync with the video.
  264.  
  265. You may adjust the absolute time shift during play by pressing the + key
  266. to increase the times (i.e. delay them) and - to decrease the times.
  267.  
  268. ABOUT THE PLAY MODES:  There are three modes; real-time, real-time with a
  269. running clock display, and step-play.
  270.  
  271. ABOUT THAT RUNNING CLOCK DISPLAY:  This is a small screen in front of the
  272. video title display.  You can drag the clock up and down.  JACOsub will
  273. raise all bottom-positioned text a little bit so that the clock won't cover
  274. up too much.  If it is covering too much for your taste, you can
  275. temporarily raise this text by inserting a command like #D VB32 in your
  276. script (see "Compiler Commands" in the file JScripts.doc).  The running
  277. clock display will also display your current ramp and shift settings.
  278.  
  279. To see how it all works, run the demo script (called demo.js).  There are
  280. three ways you can do this:
  281.  
  282.    1) From a Shell:  Just make sure that demo.js, idemo.js, and JACO.bbm
  283.       are in your scripts directory, and type this command:
  284.  
  285.       jacosub demo
  286.  
  287.    2) From Workbench:  Click once on the demo.js icon.  While holding down  
  288.       the SHIFT key, click twice on the JACOsub icon.
  289.  
  290.    3) From JACOsub:  After starting JACOsub either from the shell or from
  291.       Workbench, press L to Load a script, and select demo.js from the file
  292.       requester.
  293.  
  294.  
  295.  
  296. OPTIONAL CONFIGURATION FILE
  297. ===========================
  298.  
  299. JACOsub will set its own defaults for parameters that are omitted in the
  300. file called JACOsub.cfg (and also if the file doesn't exist).
  301.  
  302. JACOsub normally looks for a config file in the current directory.  This
  303. allows you to have different configurations stored in different places.
  304. You can specify which config file you want using the -config commandline
  305. switch, or you can run JACOsub from whichever directory that contains the
  306. desired config file.
  307.  
  308. Each line in the JACOsub.cfg file may be: a blank line, a comment (must
  309. begin with a # character), or a setting.  Settings have the following form:
  310.  
  311.    SETTING <argument1> <argument2> ...
  312.  
  313. Here are the settings and their possible arguments.  They may be either
  314. uppercase or lowercase.  The default settings indicated are what you get if
  315. you omit a particular setting from your config file.  Parameters inside
  316. brackets [] are optional.
  317.  
  318. Program Settings
  319. ----------------
  320.  
  321. CLOCKHEIGHT <NORMAL or TALL>
  322.    The running clock display can be made twice as tall as normal.  This
  323.    setting is useful if you have trouble reading the clock display during
  324.    frame-stepping in your video tape.
  325.    Default:
  326.    CLOCKHEIGHT NORMAL
  327.  
  328. DIRECTIVE <directive string>
  329.    Sets the initial global D directive for all scripts.  See the
  330.    "Directive" section in the format specification documentation
  331.    JScripts.doc.
  332.    Default:
  333.    DIRECTIVE HL1HR99VT16VB16JCJBFFDF0FO0FSSE0SNCF3CB0CS0:0:2W1
  334.  
  335. DURATIONWARN <number of seconds>
  336.    If you inadvertently set a title's start and stop times so that its
  337.    duration is too long, you might want JACOsub to warn you about it when
  338.    your script is compiled.  This problem sometimes occurs when compiling
  339.    TurboTitle scripts, where some "null" lines can have a start time of 0
  340.    and a stop time of 9 hours!  This setting lets you set the minimum title
  341.    duration that will trigger a warning during script compilation.
  342.    Default:
  343.    DURATIONWARN 120
  344.  
  345. EDITORSCREEN <scan lines> <INTERLACE or NONINTERLACE>
  346.    Sets the height and mode of the editor screen (not implemented yet).
  347.    <scan lines> must be at least 200.
  348.    Default:
  349.    EDITORSCREEN 200 NONINTERLACE.
  350.  
  351. FONT <n> <fontname.font> <size> [CLEAN or QUICK&DIRTY]
  352.    Sets font <n> to <fontname.font> which is <size> pixels high.  <n> must
  353.    range from 0 to 9.  The font should be a proportional-spaced color font,
  354.    although you can use any font.  The optional CLEAN argument (default if
  355.    omitted) tells JACOsub to display this font "cleanly," that is, to avoid
  356.    an artifact of the Amiga's text rendering operation that results in
  357.    color interference problems when rendering fonts with overlapped
  358.    characters (such as the JACOsub 36 and 29 fonts).  With CLEAN, only
  359.    color 3 text will be rendered quickly, other colors will be rendered one
  360.    character at a time instead of a line at a time.  QUICK&DIRTY forces the
  361.    font to render quickly, with the resultant color interference problems.
  362.    QUICK&DIRTY is great for mono-color fonts, and also for fonts that don't
  363.    overlap (such as those outline fonts distributed with TurboTitle).
  364.    Defaults:
  365.    FONT 0   JACOsub.font 36 CLEAN   (primary font)
  366.    FONT 1   JACOsub.font 29 CLEAN   (secondary font)
  367.    FONT 2   JACOsub.font 29 CLEAN
  368.    FONT 3   JACOsub.font 29 CLEAN
  369.    FONT 4   JACOsub.font 29 CLEAN   (Note: fonts 4 through 9 are
  370.    FONT 5   JACOsub.font 29 CLEAN   not available unless JACOsub has
  371.    FONT 6   JACOsub.font 29 CLEAN   been registered.)
  372.    FONT 7   JACOsub.font 29 CLEAN
  373.    FONT 8   JACOsub.font 29 CLEAN
  374.    FONT 9   JACOsub.font 29 CLEAN
  375.  
  376. GENLOCK <NONE or SUPERGEN>
  377.    Specifies how to interpret genlock fader control commands in a script
  378.    (see the "Directive" section in the format specification documentation
  379.    JScripts.doc).  NONE will cause such commands to be ignored.  Otherwise
  380.    JACOsub will attempt to control the type of genlock specified.
  381.    Currently only the Digital Creations SuperGen is supported, using
  382.    supergen.library version 2.0 or higher.
  383.    Default:
  384.    GENLOCK NONE
  385.  
  386. SCRIPTPATH <script path>
  387.    Tells JACOsub the directory where it should expect to find scripts.
  388.    Default:  the "scripts" directory under the current directory
  389.    SCRIPTPATH scripts
  390.  
  391. SAVECOMPILED <YES or NO>
  392.    Tells JACOsub whether or not to save compiled versions of your scripts.
  393.    Compiled scripts load up quicker than raw ASCII scripts, but they
  394.    consume more disk space.
  395.    Default:
  396.    SAVECOMPILED YES
  397.  
  398. SHADEPATTERN <line1> <line2> <line3> <line4>
  399.    Sets the shade pattern for the CS directive (see the "Directive" section
  400.    in JScripts.doc).  The pattern is bit mask 16 pixels wide and 4
  401.    scanlines high, specified by line1-line4, which must be 16-bit
  402.    hexadecimal numbers (these numbers represent each scan line for the
  403.    mask).  The default is two solid horizontal scanlines followed by two
  404.    blank scanlines, because this seems most reliable for all genlocks.
  405.    Some genlocks will grossly distort the video image if you try to specify
  406.    a complex mask (like a checkerboard, for example: 5555 AAAA 5555 AAAA).
  407.    The hexadecimal paramters may be uppercase or lowercase.
  408.    Default:
  409.    SHADEPATTERN FFFF FFFF 0000 0000
  410.  
  411. TIMEFONT <fontname.font> <size>
  412.    Sets the time-font.  This font is used for the running clock display and
  413.    also for displaying script lines while timing them.  It should be a
  414.    fixed-width, mono-color font, sufficiently large to be legible when
  415.    recorded on your videotape.  Maximum <size> is 24.  If the specified
  416.    font is not found, the Topaz 9-pixel ROM font will be used.
  417.    Default:
  418.    TIMEFONT JACOsub.font 24
  419.  
  420. USEBLITTER <YES or NO>
  421.    This setting is difficult to explain.
  422.    JACOsub generates a new video frame for each time event specified in a
  423.    script.  If the time ranges for different titles overlap, then some
  424.    titles must exist on more than one frame in order to endure through the
  425.    overlapping time events from other titles.  Generating the same text
  426.    again and again on different frames might slow down the program, so
  427.    JACOsub uses the Amiga blitter to duplicate text strings between video
  428.    frames.  This advantage in speed also has a disadvantage:  If the text
  429.    was initially generated over other imagery already on the screen (such
  430.    as other text or a shaded rectangle background), a portion of this
  431.    imagery will get blitted into the other frames along with the text.  But
  432.    suppose you did not want this imagery to survive into subsequent frames?
  433.    You can disable blitter operations, forcing all text to be generated
  434.    into each frame (instead of copying using the blitter), by specifying NO
  435.    for this parameter.  Regardless of this setting, the blitter is not used
  436.    to copy text if IFF graphic backgrounds change between subsequent frames.
  437.    Default:
  438.    USEBLITTER YES
  439.  
  440. Video Display Settings
  441. ----------------------
  442.  
  443. BITPLANES <number of bitplanes>
  444.    Sets number of bitplanes per video buffer.  2 to the power of this
  445.    number is the number of colors available.  Maximum bitplanes is 2 if
  446.    SUPERHIRES is set.  You shouldn't need to set this greater than 4 (for
  447.    16 colors).
  448.    Default:
  449.    BITPLANES 2        # 2 bitplanes = 4 colors
  450.  
  451. HRES <HIRES or SUPERHIRES>
  452.    Sets display horizontal resolution mode.  SUPERHIRES will work only if
  453.    your Amiga has the complete ECS or AGA chipsets, and your AmigaDOS
  454.    version is 2.0 or better.  Otherwise, SUPERHIRES will be interpreted
  455.    as HIRES, which is the default horizontal resolution for Workbench.
  456.    Default:
  457.    HRES HIRES
  458.  
  459. PALETTE <n> <red> <green> <blue>
  460.    Sets the red, green, and blue CRT beam intensities for color <n>.  <n>
  461.    may range from 0 to 15 (although the maximum used will be determined by
  462.    the BITPLANES setting).  <red>, <green>, and <blue> may range from 0
  463.    (off) to 15 (maximum) although for NTSC friendliness you should probably
  464.    not go beyond 13 or 14.  This initial palette may be changed by your
  465.    script, and it is active only when a script is playing.  You cannot
  466.    change the palette for the menu screen.
  467.    Defaults (please give us feeback if you have better settings!):
  468.    PALETTE 0  10 10 10       # background (transparent when genlocked)
  469.    PALETTE 1   1 14  8       # ALTERNATE font face color
  470.    PALETTE 2   0  0  0       # font outline/shadow color (SHOULD BE DARK)
  471.    PALETTE 3  13 14  5       # PRIMARY font face color
  472.    PALETTE 4  14  0  0       # red - remaining settings are arbitrary
  473.    PALETTE 5  14 14  0       # yellow
  474.    PALETTE 6   0 14  0       # green
  475.    PALETTE 7   0 14 14       # cyan
  476.    PALETTE 8   0  0 14       # blue
  477.    PALETTE 9  14  0 14       # magenta
  478.    PALETTE 10 14 10  5       # orangey
  479.    PALETTE 11  3  3  3       # gray shades...
  480.    PALETTE 12  6  6  6
  481.    PALETTE 13  9  9  9
  482.    PALETTE 14 12 12 12
  483.    PALETTE 15 14 14 14
  484.  
  485. VIDEOBUFFERS <number of buffers>
  486.    Sets the number of video buffers to use for building displays.  Minimum
  487.    number allowed is 3, maximum is 5.  Set to 3 if you are low on CHIP RAM,
  488.    of if your script doesn't do time-consuming complicated things (such as
  489.    generate outlines around a screenful of text with a graphics backdrop).
  490.    Increase the number of buffers only if you notice that JACOsub is
  491.    generating imagery on the visible screen (all image generation should
  492.    take place in the background where you cannot see it).
  493.    Default:
  494.    VIDEOBUFFERS 4
  495.  
  496.  
  497.  
  498. GENLOCK SUPPORT
  499. ===============
  500.  
  501. JACOsub allows your scripts to control the faders on a SuperGen genlock.
  502. You need to have supergen.library and copinit.library in your LIBS:
  503. directory to take advantage of this feature.  These libraries are available
  504. from the libs directory of your Digital Creations SuperGen software disk.
  505. SUPERGEN.LIBRARY VERSIONS LESS THAN 2.0 WILL NOT WORK WITH JACOsub.
  506.  
  507. Unfortunately, using SuperGen software libraries to control fades often
  508. results in jittery dissolves.  Digital Creations assures me that this
  509. behavior is improper (it's *their* software controlling the faders, so I
  510. can't do anything about it).  Manual fading might provide better results.
  511. Try it and see; perhaps it works well for you.
  512.  
  513. JACOsub will not assume control over the SuperGen until it must execute a
  514. fader command.  From that point on, the genlock will be under software
  515. control until the script play terminates, and then control will be returned
  516. to manual mode.
  517.  
  518. Warning!  DO NOT BOOT UP YOUR AMIGA WITH A SIGNAL PRESENT ON THE SUPERGEN'S
  519. VIDEO INPUT!!  Doing so will adversly affect the Amiga's system clock,
  520. which will cause your scripts to run much too fast!
  521.  
  522. Warning!  The genlock may sometimes show things that do not appear on the
  523. RGB display.  Some examples we discovered:
  524.  
  525.    A vertical line appears on the right edge of genlocked display, but not
  526.    on the RGB display.  Solution that worked for us:  Be sure the Workbench
  527.    horizontal screen size is a multiple of 32, such as 640, 672, or 704.
  528.    (2.0 users - be sure the Text Overscan preferences setting is one of
  529.    these sizes also.)  JACOsub inherits the size of its display buffers
  530.    from Workbench.  Digital Creations tells us that this line won't appear
  531.    on your videotape, but we suspect they're talking about a different
  532.    phenomenon.
  533.  
  534.    Little pieces of characters from the left side of the screen appear
  535.    on the right edge.  This happens when a character's kern setting causes
  536.    the left edge of the screen to clip off a pixel or two, as in the 'W'
  537.    and 't' of the 36-pixel JACOsub font.  You can see this when you run
  538.    the demo script after changing the left margin to 0% by inserting the
  539.    line #HL0 at the top of the script.  Solution:  Use the HL1 directive
  540.    instead of HL0, to provide a few pixels of margin space.  This will keep
  541.    kerned characters from going past the left edge of the display.
  542.  
  543. See the G directive in the Script Format Specification documentation
  544. JScripts.doc, for information on controlling the SuperGen.  Other genlocks
  545. will be supported as software and documentation becomes available to the
  546. author.
  547.  
  548.  
  549.  
  550. SCRIPT CONVERSION UTILITY
  551. =========================
  552.  
  553. Although JACOsub can read directly TurboTitle and Phoenix scripts, they
  554. won't be able to use many of JACOsub's advanced features.  If you need text
  555. with non-sequential, overlapping time ranges, or if you need to control the
  556. positioning or attributes of the text, or if you want to play a Panimator
  557. script with JACOsub, you must convert the script to the JACOsub script
  558. format.
  559.  
  560. You don't *have* to convert .pjs or .tts scripts to JACOsub format if you
  561. need only to adjust text style or color (green italics, etc.).  For these
  562. operations, you can insert style and color codes directly into your text,
  563. and still retain compatibility with your other timing software.  Your other
  564. software won't use these codes (they'll get displayed on the screen
  565. instead).  See the Script File Format Specification documentation
  566. JScripts.doc for descriptions of the possible codes that you can use.
  567.  
  568. If you need to convert to JACOsub, it's very simple.  The Shell command is
  569.  
  570.    jconvert [-v[erbose]] scriptname1.ext [scriptname2.ext] ...
  571.  
  572. where .ext can be:
  573.    .tts (TurboTitle)
  574.    .pjs (Phoenix Japanimation Society)
  575.    .tim (Generic)
  576.    .pan (Panimator)
  577.    .sub (Subtitle)
  578.  
  579. The optional -v or -verbose switch causes jconvert to echo its output to
  580. the screen.
  581.  
  582. To run jconvert from Workbench, you can click on its icon twice.  A file
  583. requester will appear, allowing you to select a file to convert.  If you
  584. have SCRIPTPATH specified in JACOsub.cfg, jconvert will use this as the
  585. starting directory for the file requester.
  586.  
  587. Or, if you need to convert multiple scripts, you may multiply select your
  588. script icons (clicking while holding down the SHIFT key) ending with a
  589. double-click on the jconvert icon.
  590.  
  591. Jconvert will read in the script, and write out a new script file called
  592. scriptname.js which will be in JACOsub format.  Then you can modify
  593. scriptname.js to take advantage of JACOsub's advanced features.
  594.  
  595. Source code for jconvert is available on request.  It should work for any
  596. computer or operating system.
  597.  
  598. NOTICE:  We recommend that you let JACOsub try to read your script PRIOR to
  599. converting it with jconvert, because JACOsub can inform you of potential
  600. problems with your script, but jconvert cannot.  For example, many
  601. TurboTitle scripts have lines where the start time starts just a little bit
  602. BEFORE the the previous line's end time.  TurboTitle will still play these
  603. lines sequentially, but JACOsub will play them as they are, with overlapped
  604. time ranges.  This will look terrible when it is played.  JACOsub will warn
  605. you of these and other problems in a non-JACOsub script.  Jconvert, on the
  606. other hand, does not analyze your scripts; it simply converts them blindly.
  607.  
  608.  
  609.  
  610. JACOsub SCRIPT FILE FORMAT SPECIFICATION
  611. ========================================
  612.  
  613. See the textfile Jscripts.doc for a complete description of the JACOsub
  614. script file format.
  615.  
  616. About those 3rd-party file formats
  617. ----------------------------------
  618.  
  619. Robert Jenks, the author of TurboTitle, made an excellent suggestion in his
  620. documentation, that the TurboTitle format should be adopted as a standard
  621. for future software.  JACOsub is compatible with TurboTitle files, but the
  622. TurboTitle format was just not flexible enough for our needs.  We needed to
  623. use SMPTE time units, we needed to control color, style, and positioning of
  624. text, we needed to insert comments in the script and inside the text, and
  625. we needed no restrictions on how time events were sequenced.  (We also
  626. needed something that displayed text faster and more cleanly, but that has
  627. nothing to do with the file format.)
  628.  
  629. The preceding paragraph is not meant to be critical of Mr. Jenks' work.
  630. TurboTitle was a fine program for its time, and it served to provide some
  631. inspirational influence for JACOsub.  TurboTitle is still a good program
  632. for timing scripts.
  633.  
  634. We feel that the JACOsub script file format is the most flexible yet
  635. developed.  Scripts can be as simple as TurboTitle scripts, containing only
  636. timing numbers and text, or you can go all out with global commands and
  637. complex directives.
  638.  
  639. We will follow the example of TurboTitle's author, and ask that the JACOsub
  640. format be adopted as a standard for future titling software products.  The
  641. format is flexible enough to evolve and grow, so if you have suggestions
  642. for improvements or changes, please let us know.
  643.  
  644. And especially, if you want JACOsub to support another file format, tell us
  645. the specifications and we'll try to work it into either the program itself
  646. or the jconvert utility.
  647.  
  648.  
  649.  
  650. SHAREWARE NOTICE
  651. ================
  652.  
  653. If you use this software for personal or hobbyist applications, and you
  654. like it, please register it (if you're a commercial user, see the next
  655. section).
  656.  
  657. Several hundred person-hours of work went into the design and development
  658. of this software.  Every effort was expended to make this program both
  659. useful and bulletproof.  If you find this software useful, a small token
  660. payment to show your thanks; yes, just a paltry $18 (US), will be greatly
  661. appreciated.  *Please* give us suggestions for improvements also!  Price
  662. is subject to change with future software revisions.
  663.  
  664. Alternate payment plan:  If you have used JACOsub to produce at least two
  665. (2) hours' worth of VHS videotape, AND you are proud of your efforts, you
  666. may send the tape(s) in lieu of payment.  We would like to see what you've
  667. done with this software.  Use your own judgment concerning copyright
  668. issues, and you may wish to contact us if you want to avoid duplicating the
  669. work of other registrants.  The author guarantees that the use of your tape
  670. will be restricted to private, non-financial purposes, and they will not be
  671. copied.  This alternate payment plan may be rescinded in the future.
  672.  
  673. Benefits of registering:
  674.  
  675. 1)  The program will look better!  The JACO logo not appear in the lower
  676. right corner of the screen during play, and your name will appear on the
  677. main screen.  You also get to use more fonts (10 instead of 4).
  678.  
  679. 2)  Shareware contributions will be split between the author(s) of this
  680. software and the Japanese Animation Club of Orlando.  You're helping a
  681. good cause.
  682.  
  683. 3)  Registering this program will also qualify you for a substantial
  684. discount on the full-fledged commercial version when (IF?) it's released.
  685. This version will have timing and editing capabilities, and possibly the
  686. ability to use frame-count timing data from a LaserDisc player.
  687.  
  688. 4)  You will be notified of future updates and bugfixes, and if you have
  689. a font that you particularly like, but it displays improperly with JACOsub,
  690. the author will be glad to re-map its bitplanes for you if you do not have
  691. a font editor that will do this.
  692.  
  693. 5)  Registering will keep your conscience from bothering you.
  694.  
  695.  
  696.  
  697. COMMERCIAL LICENSE
  698. ==================
  699.  
  700. Using this software for commercial purposes requires purchasing a license.
  701. "Commercial use" means using this software for pay or, either directly or
  702. indirectly, to produce material for sale, for rent, or for paid viewing.
  703. A commercial use license for this version of JACOsub costs US $169.  As
  704. with the shareware fee, this price is subject to change as the program
  705. expands in the future.  Alternative royalty arrangements may be negotiated
  706. in lieu of the commercial license fee.
  707.  
  708.  
  709.  
  710. LEGAL DISCLAIMER
  711. ================
  712. (Shamelessly quoted from Haventree's EasyFlow documentation)
  713.  
  714. We don't claim JACOsub is good for anything -- if you think it is, great,
  715. but it's up to you to decide.  If JACOsub doesn't work: tough.  If you
  716. lose a million because JACOsub messes up, it's you that's out the million,
  717. not us.  If you don't like this disclaimer: tough.  We reserve the right
  718. to do the absolute minimum provided by law, up to and including nothing!
  719.  
  720. This is basically the same disclaimer that comes with all other software
  721. packages, but ours is in plain English and theirs is in Legalese.
  722.  
  723.  
  724.  
  725. SUPPORT, TECHNICAL QUESTIONS, SUGGESTIONS, BUG REPORTS
  726. ======================================================
  727.  
  728. You can contact the author, Alex Matulich, at the address at the beginning
  729. of this file.  Alex may be reached via email, using the following addresses:
  730.  
  731.    Internet:  alex%bilver@peora.sdc.ccur.com
  732.               alex%bilver@uunet.uu.net, or ...uunet!bilver!alex
  733.               alex@bilver.oau.org
  734.    UUCP:      alex@bilver.uucp
  735.    Fidonet:   1:363/140 or 1:363/137, username "Alex Matulich"
  736.  
  737. Support BBS:  Anime Central 407-645-2241, N-8-1, 14,400 baud max (v.32bis),
  738.               Fidonet address 1:363/137.
  739.               The latest version of JACOsub and timed scripts contributed
  740.               by JACOsub users are in the JACOsub Support file area.
  741.               Please do not ask questions of the Sysop regarding JACOsub.
  742.               Instead please direct all questions to the author.
  743.  
  744. If you're still reading this far, thank you for using JACOsub.
  745.